package com.ruoyi.common.utils;

import com.github.pagehelper.PageHelper;
import com.ruoyi.common.core.page.PageDomain;
import com.ruoyi.common.core.page.TableSupport;
import com.ruoyi.common.utils.sql.SqlUtil;

/**
 * 分页工具类
 * PageUtils类继承自PageHelper，对分页进行了封装，提供了设置请求分页数据和清理分页线程变量的方法。
 * 该工具类主要用于在服务层或数据访问层设置分页参数，配合MyBatis和PageHelper实现分页功能。
 *
 * 注意：该类主要配合TableSupport、PageDomain和SqlUtil等类使用，用于获取请求中的分页信息并进行设置。
 * 在使用此工具类时，需要先调用startPage()方法设置分页参数，然后在查询数据之后调用clearPage()方法清理线程变量。
 *
 * 使用示例：
 *
 * // 设置请求分页数据
 * PageUtils.startPage();
 *
 * // 进行数据库查询操作
 * List<DataEntity> dataList = dataMapper.getDataList();
 *
 * // 清理分页线程变量
 * PageUtils.clearPage();
 *
 * 注意：在实际项目中，数据查询和分页设置的业务逻辑可能会有所不同，需要根据实际情况调整使用方法。
 *
 * @author ruoyi
 */
public class PageUtils extends PageHelper
{
    /**
     * 设置请求分页数据
     * 通过TableSupport.buildPageRequest()获取请求中的分页信息，然后使用PageHelper.startPage()方法设置分页参数。
     */
    public static void startPage()
    {
        PageDomain pageDomain = TableSupport.buildPageRequest();
        Integer pageNum = pageDomain.getPageNum();
        Integer pageSize = pageDomain.getPageSize();
        String orderBy = SqlUtil.escapeOrderBySql(pageDomain.getOrderBy());
        Boolean reasonable = pageDomain.getReasonable();

        // 调用PageHelper的startPage()方法设置分页参数
        PageHelper.startPage(pageNum, pageSize, orderBy).setReasonable(reasonable);
    }

    /**
     * 清理分页的线程变量
     * 调用PageHelper的clearPage()方法，清理分页的线程变量，防止线程池重用线程时带入上一次的分页信息。
     */
    public static void clearPage()
    {
        PageHelper.clearPage();
    }
}
